Inside Macintosh: 3D Graphics Programming With QuickDraw 3D /

Chapter 16 - Storage Objects

Summary of Storage Objects

C Summary

Constants

#define kQ3StorageTypeMemory           Q3_OBJECT_TYPE('m','e','m','s')
#define kQ3StorageTypeMacintosh        Q3_OBJECT_TYPE('m','a','c','n')
#define kQ3StorageTypeUnix             Q3_OBJECT_TYPE('u','x','s','t')
#define kQ3MemoryStorageTypeHandle     Q3_OBJECT_TYPE('h','n','d','l')
#define kQ3MacintoshStorageTypeFSSpec  Q3_OBJECT_TYPE('m','a','c','p')
#define kQ3UnixStorageTypePath         Q3_OBJECT_TYPE('u','x','i','x')

Storage Objects Routines

Managing Storage Objects

TQ3ObjectType Q3Storage_GetType (
TQ3StorageObject storage);
TQ3Status Q3Storage_GetSize(TQ3StorageObject storage, 
unsigned long *size);
TQ3Status Q3Storage_GetData(TQ3StorageObject storage, 
unsigned long offset, 
unsigned long dataSize, 
unsigned char *data, 
unsigned long *sizeRead);
TQ3Status Q3Storage_SetData(TQ3StorageObject storage, 
unsigned long offset, 
unsigned long dataSize, 
const unsigned char *data, 
unsigned long *sizeWritten);

Creating and Accessing Memory Storage Objects

TQ3StorageObject Q3MemoryStorage_New (
const unsigned char *buffer, 
unsigned long validSize);
TQ3StorageObject Q3MemoryStorage_NewBuffer (
unsigned char *buffer, 
unsigned long validSize, 
unsigned long bufferSize);
TQ3Status Q3MemoryStorage_Set(TQ3StorageObject storage, 
const unsigned char *buffer, 
unsigned long validSize);
TQ3Status Q3MemoryStorage_GetBuffer (
TQ3StorageObject storage, 
unsigned char **buffer, 
unsigned long *validSize, 
unsigned long *bufferSize);
TQ3Status Q3MemoryStorage_SetBuffer (
TQ3StorageObject storage, 
unsigned char *buffer, 
unsigned long validSize, 
unsigned long bufferSize);
TQ3ObjectType Q3MemoryStorage_GetType (
TQ3StorageObject storage);

Creating and Accessing Handle Storage Objects

TQ3StorageObject Q3HandleStorage_New (
Handle handle, unsigned long validSize);
TQ3Status Q3HandleStorage_Get(TQ3StorageObject storage, 
Handle *handle, 
unsigned long *validSize);
TQ3Status Q3HandleStorage_Set(TQ3StorageObject storage, 
Handle handle, 
unsigned long validSize);

Creating and Accessing Macintosh Storage Objects

TQ3StorageObject Q3MacintoshStorage_New (
short fsRefNum);
TQ3Status Q3MacintoshStorage_Get (
TQ3StorageObject storage, short *fsRefNum);
TQ3Status Q3MacintoshStorage_Set (
TQ3StorageObject storage, short fsRefNum);
TQ3ObjectType Q3MacintoshStorage_GetType (
TQ3StorageObject storage);

Creating and Accessing FSSpec Storage Objects

TQ3StorageObject Q3FSSpecStorage_New (
const FSSpec *fs);
TQ3Status Q3FSSpecStorage_Get(TQ3StorageObject storage, FSSpec *fs);
TQ3Status Q3FSSpecStorage_Set(TQ3StorageObject storage, const FSSpec *fs);

Creating and Accessing UNIX Storage Objects

TQ3StorageObject Q3UnixStorage_New (
FILE *stdFile);
TQ3Status Q3UnixStorage_Get(TQ3StorageObject storage, FILE **stdFile);
TQ3Status Q3UnixStorage_Set(TQ3StorageObject storage, FILE *stdFile);
TQ3ObjectType Q3UnixStorage_GetType (
TQ3StorageObject storage);

Creating and Accessing UNIX Path Name Storage Objects

TQ3StorageObject Q3UnixPathStorage_New (
const char *pathName);
TQ3Status Q3UnixPathStorage_Get (
TQ3StorageObject storage, 
char *pathName);
TQ3Status Q3UnixPathStorage_Set (
TQ3StorageObject storage, 
const char *pathName);

Errors

kQ3ErrorAccessRestricted
kQ3ErrorBadFormatString
kQ3ErrorInvalidName
kQ3ErrorStorageInUse
kQ3ErrorStorageAlreadyOpen
kQ3ErrorStorageNotOpen
kQ3ErrorStorageIsOpen